Skip to main content

Invoke-ImmichMethod

SYNOPSIS​

Invokes custom Immich API methods.

SYNTAX​

Invoke-ImmichMethod [[-Session] <ImmichSession>] [[-Headers] <Hashtable>] [[-QueryParameters] <Hashtable>]
 [[-BodyParameters] <Hashtable>] [[-Method] <String>] [[-RelativeURI] <String>] [[-ContentType] <String>]
 [[-OutFilePath] <FileInfo>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Makes direct API calls to Immich endpoints with custom parameters and headers.

EXAMPLES​

EXAMPLE 1​

Invoke-ImmichMethod

Retreives all Immich server info properties

PARAMETERS​

-Session​

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Headers​

Custom HTTP headers for the request.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-QueryParameters​

URL query parameters as hashtable.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BodyParameters​

Request body parameters.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Method​

HTTP method (GET, POST, PUT, DELETE, etc.).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RelativeURI​

API endpoint path relative to server URL.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContentType​

ContentType

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: Application/json
Accept pipeline input: False
Accept wildcard characters: False

-OutFilePath​

OutFilePath

Type: FileInfo
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github